Copper Work Order API
API Resources
The Copper Work Order API includes the following resources:
| Name | Function | HTTP method |
|---|---|---|
| Get API version | Returns the API version | /version |
| Get Events | Get list of events that represent the ‘dispatched’ Service Orders during a specified time interval. | /events?interval=24 |
| Get Order | Returns attributes for an existing Service Order. | /orders/{orderid} |
| Get Order Memo | Returns memo text of the Order in JSON format. Lines in the text are separated with "\n". The standard JSON code page is formatted as UTF-8. | /orders/{orderid}/memo |
| Get Line Card | Returns attributes of the Service Order Line Card | /orders/{orderid}/linecard |
| Get Order Default Schedule | Returns default work force schedule details for the order | /orders/{orderid}/schedule |
| Get Sales Order Details | Returns attributes for the existing Sales Order | /salesorders/{salesorderid} |
| Change Order Stage | Changes the stage code of a given Service Order. | /orders/{orderid}/stage |
| Add Message to the Order Memo | Add a text message to the Order memo. The message can be added at the top or bottom of the existing memo. | /orders/{orderid}/memo |
| Change Order Due Date | Change Due Date and Time of an order. | /orders/{orderid}/duedate |
| Change Effective Completion Date | Set Effective Completion Date of an order. | /orders/{orderid}/effcompletiondate |
| Change the assigned Service company | Updates the ‘assigned to’ attribute to reflect the Service company codes. | /orders/{orderid}/assignedto |